Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

nixos: remove mdDoc from nixos/modules #300745

Closed
wants to merge 2 commits into from
Closed

nixos: remove mdDoc from nixos/modules #300745

wants to merge 2 commits into from

Conversation

philiptaron
Copy link
Contributor

Description of changes

Since #237557 was merged, lib.mdDoc has been a no-op. Let's remove it.

The tracking issue is #300735.

Things done

  • nix-build doc/default.nix

@github-actions github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 6.topic: GNOME GNOME desktop environment and its underlying platform 6.topic: qt/kde 8.has: module (update) This PR changes an existing module in `nixos/` 6.topic: emacs Text editor 6.topic: printing 6.topic: vim 6.topic: xfce The Xfce Desktop Environment 6.topic: pantheon The Pantheon desktop environment 6.topic: cinnamon Desktop environment 6.topic: systemd 6.topic: LXQt The Lightweight Qt Desktop Environment 6.topic: Lumina DE The Lumina Desktop Environment labels Apr 1, 2024
@github-actions github-actions bot added 6.topic: Enlightenment DE The Enlightenment Desktop Environment 6.topic: mate The MATE Desktop Environment 6.topic: flakes The experimental Nix feature 6.topic: jupyter Interactive computing tooling: kernels, notebook, jupyterlab labels Apr 1, 2024
@philiptaron philiptaron removed request for a team and zowoq April 1, 2024 17:53
@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10 labels Apr 1, 2024
@philiptaron
Copy link
Contributor Author

I can split these up into multiple PRs. Considering how fast a merge conflict came up, I likely should do that.

@philiptaron philiptaron force-pushed the issue-300735/nixos/modules branch from b2debad to 978482e Compare April 1, 2024 19:39
@emilylange
Copy link
Member

Did you do that with just sed?
Because you have trunks that

  • drop newlines in inherit (lib) that should stay

  • add a comma between the most right key of inherits and the semicolon (;)

  • change e.g.

     enable = mkEnableOption (
   lib.mdDoc ''
     lorem ipsum
   ''
 );

    into

     enable = mkEnableOption ( ''
     lorem ipsum
   ''
 );

  • replace mkEnableOption (mdDoc "lorem ipsum"); with mkEnableOption ( "lorem ipsum");

  • and likely other formatting related issues

How about deferring this until nixfmt (RFC 166) has been run tree-wide?
Or how about a more sophisticated script, if you believe this is worth the effort?

@philiptaron
Copy link
Contributor Author

I did it a little more sophisticated than sed, with vim and :argdo. I can see that that mkEnableOption commit didn't do it right. I'll pursue both a more targeted approach than 1695 files changed and with a more tested script.

@philiptaron philiptaron closed this Apr 1, 2024
@philiptaron philiptaron deleted the issue-300735/nixos/modules branch April 1, 2024 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mic92 Mic92 Awaiting requested review from Mic92

@RaitoBezarius RaitoBezarius Awaiting requested review from RaitoBezarius

@SuperSandro2000 SuperSandro2000 Awaiting requested review from SuperSandro2000

@bendlas bendlas Awaiting requested review from bendlas

@emilylange emilylange Awaiting requested review from emilylange

@piegamesde piegamesde Awaiting requested review from piegamesde

@peti peti Awaiting requested review from peti

@mweinelt mweinelt Awaiting requested review from mweinelt

@thoughtpolice thoughtpolice Awaiting requested review from thoughtpolice

@joachifm joachifm Awaiting requested review from joachifm

@samueldr samueldr Awaiting requested review from samueldr

@JulienMalka JulienMalka Awaiting requested review from JulienMalka

@grahamc grahamc Awaiting requested review from grahamc

@cole-h cole-h Awaiting requested review from cole-h

@dasJ dasJ Awaiting requested review from dasJ

Assignees
No one assigned
Labels
6.topic: cinnamon Desktop environment 6.topic: emacs Text editor 6.topic: Enlightenment DE The Enlightenment Desktop Environment 6.topic: flakes The experimental Nix feature 6.topic: GNOME GNOME desktop environment and its underlying platform 6.topic: jupyter Interactive computing tooling: kernels, notebook, jupyterlab 6.topic: Lumina DE The Lumina Desktop Environment 6.topic: LXQt The Lightweight Qt Desktop Environment 6.topic: mate The MATE Desktop Environment 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 6.topic: pantheon The Pantheon desktop environment 6.topic: printing 6.topic: qt/kde 6.topic: systemd 6.topic: vim 6.topic: xfce The Xfce Desktop Environment 8.has: module (update) This PR changes an existing module in `nixos/` 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin 10.rebuild-linux: 1-10
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@philiptaron @emilylange